AsyncAPI for the REST API macroservice. This service both publishes and subscribes to several events and also exposes Server-Sent Events (SSE) to the frontend (HTTP-based push).
RabbitMQ broker (env CLOUDAMQP_URL supported)
Queue published when a stalking analysis is requested (service publishes).
Publish request to start stalking analysis
Available only on servers:
Accepts the following message:
Request to start stalking analysis for given social URLs.
Additional properties are allowed.
{
"facebookUrl": "string",
"instagramUrl": "string",
"tiktokUrl": "string",
"youtubeUrl": "string",
"xUrl": "string",
"linkedinUrl": "string",
"chatId": "string"
}
Queue published when chat interview starts (service publishes).
Publish start of chat interview
Available only on servers:
Accepts the following message:
Start of the chat interview flow.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"context": {},
"history": [
{}
]
}
Queue published when user answers in chat (service publishes).
Publish user's chat answer
Available only on servers:
Accepts the following message:
User answered during chat interview.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"context": {},
"messages": [
{}
]
}
Queue published to request gift generation (service publishes).
Publish request to generate gift ideas
Available only on servers:
Accepts the following message:
Request to generate gift ideas.
Additional properties are allowed.
Additional properties are allowed.
{
"keywords": [
"string"
],
"chatId": "string",
"profile": {}
}
Queue the service subscribes to when stalking is completed.
Consume stalking completed events
Available only on servers:
Accepts the following message:
Stalking analysis completed with extracted keywords.
Additional properties are allowed.
{
"keywords": [
"string"
],
"completedAt": "2019-08-24T14:15:22Z",
"chatId": "string"
}
Queue the service subscribes to for question asked notifications.
Consume chat question asked
Available only on servers:
Accepts the following message:
Question asked by the user during chat.
Additional properties are allowed.
Additional properties are allowed.
{
"question": "string",
"context": {
"keywords": [
"string"
],
"chatId": "string"
}
}
Queue the service subscribes to for interview completion.
Consume chat interview completed
Available only on servers:
Accepts the following message:
Interview flow finished with computed profile.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"context": {},
"profile": {}
}
Queue the service subscribes to to receive generated gift ideas.
Consume generated gift ideas
Available only on servers:
Accepts the following message:
Generated gift ideas ready to consume.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"giftIdeas": [
{
"image": "http://example.com",
"title": "string",
"description": "string",
"link": "http://example.com",
"price": {
"value": 0,
"label": "string",
"currency": "string",
"negotiable": true
}
}
],
"chatId": "string"
}
Queue the service subscribes to for inappropriate requests.
Consume inappropriate requests
Available only on servers:
Accepts the following message:
The request was flagged as inappropriate.
Additional properties are allowed.
{
"reason": "string",
"chatId": "string"
}
Request to start stalking analysis for given social URLs.
Additional properties are allowed.
Start of the chat interview flow.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User answered during chat interview.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Request to generate gift ideas.
Additional properties are allowed.
Additional properties are allowed.
Stalking analysis completed with extracted keywords.
Additional properties are allowed.
Question asked by the user during chat.
Additional properties are allowed.
Additional properties are allowed.
Interview flow finished with computed profile.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Generated gift ideas ready to consume.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The request was flagged as inappropriate.
Additional properties are allowed.